home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 2002 November / SGI Freeware 2002 November - Disc 2.iso / dist / fw_gnome-libs.idb / usr / freeware / catman / u_man / cat1 / gnome-doc.Z / gnome-doc
Text File  |  2002-07-08  |  3KB  |  89 lines
  1. GNOME-DOC(1)                         GNOME-DOC(1)
  2.  
  3.  
  4.  
  5. NNAAMMEE
  6.        gnome-doc - Documentation tool for GNOME
  7.  
  8. SSYYNNOOPPSSIISS
  9.        ggnnoommee--ddoocc  [  --ddooccbbooookk ||    --hhttmmll ||    --tteexxtt ||    --mmaann  ]    [  --ffuunncc
  10.        ttiioonn ffuunnccnnaammee [[ --ffuunnccttiioonn ffuunnccnnaammee ......]]    ] [  cc ffiilleess  ]
  11.  
  12.  
  13. DDEESSCCRRIIPPTTIIOONN
  14.        ggnnoommee--ddoocc This will read    a 'c' file and scan for     embedded
  15.        comments    in the style of    gnome comments (+minor extensions
  16.        - see below).
  17.  
  18.        All output goes to stdout, with errors to stderr.
  19.  
  20. OOPPTTIIOONNSS
  21.        --ddooccbbooookk    --hhttmmll --tteexxtt --mmaann
  22.           Set output format    using one of -docbook -html -text
  23.           or -man.    Default    is man.
  24.  
  25.        --ffuunnccttiioonn
  26.           If  set,    then  only generate documentation for the
  27.           given function(s). All other functions are ignored.
  28.  
  29.        cc ffiilleess
  30.           list of 'c' files    to process
  31.  
  32. FFOORRMMAATT OOFF CCOOMMMMEENNTTSS
  33.        In the following    table,
  34.  
  35.          (...)?    signifies optional structure.
  36.          (...)*    signifies 0 or more structure elements.
  37.  
  38.            /**
  39.          * function_name(:)? (- short description)?
  40.          * @parameterx: (description of parameter x)?)*
  41.         (* a blank line)?
  42.          * (Description:)? (Description of function)?
  43.          * (section    header:    (section description)? )*
  44.         (*)?*/
  45.  
  46.          So    .. the trivial example would be:
  47.          /**
  48.           *    my_function
  49.           **/
  50.  
  51.          If    the Description: header    tag is omitted,    then there must    be a blank
  52.          line after    the last parameter specification.
  53.           e.g.
  54.         /**
  55.          * my_function - does my stuff
  56.          * @my_arg:    its mine damnit
  57.          *
  58.          * Does my stuff explained.
  59.          */
  60.  
  61.         or,    could also use:
  62.         /**
  63.          * my_function - does my stuff
  64.          * @my_arg:    its mine damnit
  65.          * Description: Does my stuff explained.
  66.          */
  67.         etc.
  68.  
  69.         All    descriptions can be multiline, apart from the short function
  70.         description.
  71.  
  72.         All    descriptive text is further processed, scanning    for the
  73.         following special patterns,    which are highlighted appropriately.
  74.  
  75.         funcname()    - function
  76.         $ENVVAR    - environmental    variable
  77.         struct_name    - name of a structure
  78.         @parameter    - name of a parameter
  79.         %CONST    - name of a constant.
  80.  
  81. AAUUTTHHOORR
  82.        This manual page    was written by Christian Marillat <maril
  83.        lat@debian.org> for the Debian GNU/Linux    system    (but  may
  84.        be used by others).
  85.  
  86.  
  87.  
  88.               09 januar 2002         GNOME-DOC(1)
  89.